home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 43 / Mac Magazin and MacEasy Magazine CD - Issue 43.iso / Software / Mobiles Büro / Newton / Newton Utilities / NewtDB 1.3 ƒ / Newton Script Spport / Names Soup Format.txt next >
Text File  |  1997-09-13  |  12KB  |  172 lines
  1. Names Soup Format from pg 16-15 of the NPReference manual in Docviewer format.
  2. For best viewing, set your tabs stops to 20 chars.
  3.  
  4. This section describes the format of entries in the Names soup. Five different types of entries are stored in this soup: persons, owners, groups, companies, and worksites. You can identify an entry by calling the ClassOf function on the entry. ClassOf(entry) returns one of the following symbols: 'person, 'owner, 'group, 'company, or 'worksite. 
  5. The slots contained in these entry frames are described in “Person Entries” (page 16-15), “Owner Entries” (page 16-18), “Group Entries” (page 16-20), “Company Entries” (page 16-21), and “Worksite Entries” (page 16-22).
  6.  
  7. Person Entries
  8.  
  9. Person entries consist of a frame with the following slots:
  10. Slot descriptions
  11. version    The version number of the Names application.
  12. class    The symbol 'person.
  13. cardType    An integer; see Table 16-1 “Names card layouts.”
  14. name     A frame with the following slots:
  15.     honorific    A string or rich string for an honorific title; e.g., “Ms.” or “Dr.”
  16.     first    A string or rich string for a first name.
  17.     last    A string or rich string for a last name.
  18.     title    A string or rich string for a job title.
  19. names    An array of affiliated names, such as company contacts, family members, and so on, added by the user by picking “Affiliate” from the “Add” picker. This array contains frames such as that for the name slot.
  20. company    A string or rich string for the company name.
  21. title    A string or rich string representing this person’s title at the company stored in company.
  22. companies    An array of frames of type {company: stringOrRichString, title: stringOrRichString}. 
  23. address    A string or rich string for the first line of an address.
  24. address2    A string or rich string for the second line of an address.
  25. addresses    An array of frames for additional addresses. These frames contain the following slots: address, address2, city, region, postal_code, and country. 
  26.     city    A string or rich string for a city.
  27.     region    A string or rich string for region (a state in the U.S.).
  28.     postal_code    A string or rich string for postal code (zip code in U.S.).
  29.     country    A or rich string naming the country. If this is a standard (not rich) string that is recognized by the system as the name of a country, it will have a class as set by SetCountryClass; for more information on this, see the description of SetCountryClass.
  30. phones    An array that contains strings or rich strings for phone numbers. The user can set the class of this string by picking from the Phones popup. The built-in phone classes are:
  31.     phone
  32.     homePhone
  33.     workPhone
  34.     faxPhone
  35.     carPhone
  36.     mobilePhone
  37.     homefaxPhone
  38. email    A string or rich string for an e-mail address. The user can set the class of this string by picking from the Email popup. The built-in e-mail classes are:
  39.     |string.email|
  40.     |string.email.internet|
  41.     |string.email.aol|
  42.     |string.email.compuserve|
  43.     |string.email.mcimail|
  44.     |string.email.attmail|
  45.     |string.email.easylink|
  46.     |string.email.prodigy|
  47.     |string.email.genie|
  48.     |string.email.delphi|
  49.     |string.email.msn|
  50.     |string.email.interchange|
  51.     |string.email.radiomail|
  52. emailAddrs    An array of frames of additional e-mail addresses with the following slot:
  53. email     A string or rich string. The user can set the class of this string by picking from the Email popup. The built-in e-mail classes are listed under the email slot.
  54. emailPassword    Always nil.
  55. pagers    An array of pager information frames. Each frame can have the following slots:
  56. pagerNum    A string or rich string for a pager number. The user can set the class of this string by picking from the Pagers popup. The built-in pagers classes are:
  57.     |string.pager|
  58.     |string.pager.skytel|
  59.     |string.pager.mobilcomm|
  60.     |string.pager.embarc|
  61. pagerPIN    A string or rich string for a pager PIN.
  62. bday    Either an integer for the date the user entered for the birthday in the number of minutes passed since midnight, January 1, 1904, or a string or rich string. 
  63. bdayEvent    An alias to a Dates event. For more information on entry aliases, see Chapter 11, “Data Storage and Retrieval,” in Newton Programmer’s Guide.
  64. anniversary    Either an integer for the date the user entered for the anniversary, in the number of minutes passed since midnight, January 1, 1904, or a string or rich string.
  65. anniversaryEvent
  66. An alias to a Dates event. For more information on entry aliases, see Chapter 11, “Data Storage and Retrieval,” in Newton Programmer’s Guide.
  67. notes    An array of note objects. Each element in this array is a frame with the same format as the data slot in a soup entry in the Notes application; see “Notes Soup Format” (page 16-82).
  68. sorton    A string (not a rich string because of sorting).
  69.  
  70. Owner Entries
  71.  
  72. Owner entries consist of a frame with the same slots as in “Person Entries” (page 16-15). However, three of the slots hold different values, and there is an additional slot. The following three slots exist in person entries, but have different meanings:
  73. Slot descriptions
  74. class    The symbol 'owner.
  75. emailPassword    A string for the owner’s e-mail password.
  76. emailAddrs    An array of frames of additional e-mail addresses with the following slots:
  77. email     A string or rich string. The user can set the class of this string by picking from the Email popup. The built-in e-mail classes are listed under the email slot for person entries.
  78. emailpassword
  79. A string.
  80. There is one additional slot in owner entries:
  81. owner    A frame with the slots shown below.
  82. Slot descriptions for owner frame
  83. bankAccounts    An array of frames corresponding to bank accounts. These frames contain the following slots:
  84. bankAcctNum
  85. A string or rich string that contains the account number.
  86. bankContactNum
  87. A phone number string or rich string for the bank account contact.
  88. creditCards    An array of frames corresponding to credit card accounts. These frames contain the following slots:
  89. creditCardName
  90. A string or rich string for the credit card’s name. The user can set the class of this string by picking from the Card popup. The built-in credit card classes are: 
  91.        |string.card|
  92.        |string.card.phonecard|
  93.        |string.card.creditcard|
  94.        |string.card.phonecard.att|
  95.        |string.card.phonecard.mci|
  96.        |string.card.phonecard.sprint|
  97.        |string.card.creditcard.visa|
  98.        |string.card.creditcard.mastercard|
  99.        |string.card.creditcard.amex|
  100.        |string.card.creditcard.discover|
  101. creditCardNum
  102. A string or rich string for the account number.
  103. creditCardExpDate
  104. Either an integer for the expiration date, in number of minutes since midnight, January 1, 1904, or a string or rich string.
  105. creditCardContactNum
  106. A string or rich string for the phone number of the credit card account contact.
  107. signature    The signature the user entered in the signature slip. It is an ink frame.
  108.  
  109. Group Entries
  110.  
  111. A group entry consists of a frame with the following slots:
  112. version    The version number of the Names application.
  113. class    The symbol 'group.
  114. cardType    An integer; see Table 16-1 “Names card layouts.”
  115. group    A string or rich string for the group’s name.
  116. groupInfo    Contains a frame with the following slot:
  117. nowShowing    Either the value 'selected or 'all. This reflects whether the user has checked the Selected Only box in the view that adds people to the group.
  118. members    An array containing name reference frames representing the members of the group. These frames are described in “Name References” (page 5-1) in Newton Programmer’s Reference. 
  119. notes    An array of note objects. Each element in this array is a frame with the same format as the data slot in a soup entry in the Notes application; see “Notes Soup Format” (page 16-82).
  120. sorton    A string (not a rich string because of sorting).
  121.  
  122.  
  123. Company Entries
  124.  
  125. Company entries consist of a frame with the following slots: 
  126. version    The version number of the Names application.
  127. class    The symbol 'company.
  128. name    The name the user added by picking “affiliate” from the Add picker. It is a frame with the following slots:
  129. honorific    A string or rich string for an honorific title, e.g., “Ms.” or “Dr.”
  130. first    A string or rich string for a first name.
  131. last    A string or rich string for a last name.
  132. title    A string or rich string for a job title.
  133. names    An array of affiliated names; as added by the user by picking “Affiliate” from the “Add” picker, such as company contacts, family members, and so on. This array contains frames such as that for the name slot.
  134. cardType    An integer; see Table 16-1 “Names card layouts.”
  135. company    A string or rich string for the company name.
  136. address    A string or rich string for the first line of the address.
  137. address2    A string or rich string for the second line of the address.
  138. addresses    An array of frames for additional addresses. These frames contain the following slots: address, address2, city, region, postal_code, and country. 
  139.     city    A string or rich string containing the name of a city.
  140.     region    A string or rich string for region (state in U.S., province in Canada).
  141.     postal_code    A string or rich string for postal code (zip code in U.S.).
  142.     country    A or rich string naming the country. If this is a standard (not rich) string that is recognized by the system as the name of a country, it will have a class as set by SetCountryClass; for more information on this, see the description of SetCountryClass.
  143. phones    An array of strings or rich strings containing phone numbers. The user can set the class of these string by picking from the Phone popup. The built-in phone classes are listed under the phones slot for person entries.
  144. email    A string or rich string for an e-mail address. The user can set the class of this string by picking from the Email popup. The built-in e-mail classes are listed under the email slot for person entries. 
  145. emailAddrs    An array of frames of additional e-mail addresses of the format {email:stringOrRichString}.
  146. notes    An array of note objects. Each element in this array is a frame with the same format as the data slot in a soup entry in the Notes application; see “Notes Soup Format” (page 16-82).
  147. sorton    A string (not a rich string because of sorting).
  148.  
  149. Worksite Entries
  150.  
  151. Worksite entries consist of a frame with the following slots:
  152. version    The version number of the Names application.
  153. class    The symbol 'worksite.
  154. cardType    An integer; see Table 16-1 “Names card layouts.”
  155. place    A string or rich string for the place name.
  156. dialingPrefix    A string or rich string for dialing prefix needed to get an outside line from this worksite.
  157. areaCode    A string or rich string for the area code of this worksite.
  158. printer    A string representing the printer the user has chosen from among network printers.
  159. mailAccess    An array of frames of the following form: {mailPhone:stringOrRichString, mailNetwork:'concert, 
  160.     baud:1200}
  161. connectionPhone    A phone number string to access e-mail at this site.
  162. connectionNetwork
  163. A string for the AppleTalk Name Binding Protocol (NBP) address. The format of this string is "computerName:Docker@zone".
  164. cityAlias     An alias to an entry from an undocumented soup which contains informations about the closest city. The soup entry contains slots for the city name, its country, latitude and longitude, etc.
  165.     For more information on entry aliases, see Chapter 11, “Data Storage and Retrieval,” in Newton Programmer’s Guide.
  166. countrySymbol    A symbol representing the country.
  167. country    A or rich string naming the country. If this is a standard (not rich) string that is recognized by the system as the name of a country, it will have a class as set by SetCountryClass; for more information on this, see the description of SetCountryClass.
  168. notes    An array of note objects. Each element in this array is a frame with the same format as the data slot in a soup entry in the Notes application; see “Notes Soup Format” (page 16-82).
  169. sorton    A string (not a rich string because of sorting).
  170.  
  171. -30-
  172.